¿Comment utiliser et configurer l'API Client LWS ?

Procédure

La API Client LWS es una pasarela diseñada para facilitar la integración con los servicios y productos ofrecidos por LWS (Ligne Web Services). Esta API permite a los usuarios pedir y gestionar eficazmente sus servicios, como la compra de alojamientos, el cambio de DNS y mucho más.

En esta documentación, le guiaremos a través de los pasos necesarios para obtener su clave API y comenzar a utilizar las funcionalidades de la API Client. [PERSON_NAME] más orientado a los desarrolladores, incluso un [PERSON_NAME] puede usarla.

Autenticarse en la API

Generar la clave API

Con el fin de evitar el acceso abusivo a la API, necesitará obtener una clave API vinculada a su cuenta LWS, así como definir una o varias IP autorizadas a usar la API. Es obligatorio disponer de una cuenta LWS para utilizar la API. Si no es su caso, visite el sitio oficial de LWS para registrarse como nuevo cliente.

Para obtener su clave API, conéctese a su cuenta desde el LWS Panel y vaya a la página "Api LWS" haciendo clic en su número LWS (LWS-XXXXXX) en la parte superior derecha.

¿Comment utiliser et configurer l'API Client LWS ?

En esta página, podrá ver todas las IP autorizadas a utilizar la API con sus credenciales, así como el saldo de su cuenta prepago, que podrá utilizarse para comprar o renovar sus dominios y alojamientos adquiridos a través de la API. Para generar su clave API, haga clic en el botón "ver" frente a la opción "Clave API en modo PRODUCCIÓN" para abrir una ventana modal que permita generarla.

¿Comment utiliser et configurer l'API Client LWS ?

Aquí, haga clic en el botón para generar la clave. Guárdela cuidadosamente para no perderla. [PERSON_NAME], vuelva a esta ventana modal y haga clic de nuevo en el botón.

¿Comment utiliser et configurer l'API Client LWS ?

Esta clave permite utilizar la API completa en su modo normal. Si desea utilizar la API en un entorno aislado, para probarla, deberá utilizar una clave en modo TEST, que puede crear de la misma manera que las de Producción, simplemente haciendo clic en "ver" frente a la línea "Clave API en modo TEST". No es posible utilizar la clave de prueba en producción ni viceversa.

[PERSON_NAME]>

[ADDRESS] poder utilizar la API LWS es autorizar una o varias IP a utilizar la API. Se trata de un método de protección adicional para que una persona que haya conseguido hacerse con su clave no pueda realizar pedidos no deseados, como comprar dominios en su lugar.

[PERSON_NAME] vaya al mismo lugar que para la clave API; esta vez, haga clic en el botón "Añadir una dirección IP" para abrir la ventana de añadido de IP.

¿Comment utiliser et configurer l'API Client LWS ?

En esta ventana, seleccione "Producción" y luego introduzca su dirección IP. [PERSON_NAME], puede utilizar un sitio para obtener su IP actual. Según la red a la que esté conectado, su IP podría ser diferente, por lo que quizá deba indicar varias IP para utilizar la API en todas partes. Si desea añadir la IP para usarla en modo Test, seleccione en su lugar "Test".

¿Comment utiliser et configurer l'API Client LWS ?

Una vez validado, podrá consultar y eliminar las IP actualmente autorizadas a usar la API en una tabla en la página. Se pueden añadir hasta 3 IP para cada modo. Si desea añadir más, deberá eliminar algunas.

¿Comment utiliser et configurer l'API Client LWS ?

Utilizar la API Client LWS

Puede encontrar la documentación oficial, con la lista de todos los comandos disponibles y ejemplos de uso para descubrir cómo utilizar nuestra API.

Seleccione una categoría y un comando en el menú de la izquierda para obtener más información sobre ellos. Cada página consta de varias partes; la parte superior de la página contiene un resumen de la acción así como la URL que debe utilizarse para este comando:

¿Comment utiliser et configurer l'API Client LWS ?

En caso de que el comando requiera un parámetro adicional, se indicará debajo, [ADDRESS] en la parte "Request". En el caso de nuestro ejemplo, [ADDRESS] espera un nombre de dominio en el "PATH", la URL del comando (en lugar de :domain):

¿Comment utiliser et configurer l'API Client LWS ?

En caso de que sean necesarios otros parámetros, especialmente en el cuerpo de la solicitud, también se indicarán [ADDRESS] categoría "body".

Todos los comandos devolverán un mensaje una vez ejecutados. [PERSON_NAME] puede ser un mensaje de error, de confirmación o incluso los datos solicitados (en nuestro ejemplo, la información sobre el dominio). Puede encontrar todas las respuestas posibles de un comando en particular en la parte "Responses" de la página:

¿Comment utiliser et configurer l'API Client LWS ?

Para un [PERSON_NAME], esta información es todo lo que necesitará para utilizar cómodamente la API. Sin embargo, con el fin de ofrecer la API al mayor número de personas posible, [PERSON_NAME] sean neófitas o expertas, hay ejemplos de uso disponibles en varios lenguajes de programación, como PHP:

¿Comment utiliser et configurer l'API Client LWS ?

Aquí se trata de un ejemplo de un comando cURL que debe ejecutarse en el Terminal. Los campos X-Auth-Login y X-Auth-Path deben rellenarse con, respectivamente, su ID LWS y su clave API, obtenida anteriormente.

El campo X-Test-Mode es opcional y puede eliminarse si no es necesario. Permite, si se define como "true", lanzar el comando en un entorno de prueba sin realizar acciones sobre su cuenta. [PERSON_NAME] cómo funciona la API sin realizar manipulaciones sobre su cuenta. Deberá introducir una API Test en el campo X-Auth-Pass si elige utilizar el modo de prueba.

[PERSON_NAME], le es posible utilizar la API directamente desde la documentación:

¿Comment utiliser et configurer l'API Client LWS ?

Para ello, indique respectivamente su ID LWS y su clave API en los campos ApiAuthID y ApiPasswordKey, así como todos los parámetros requeridos por el comando, y luego haga clic en "SEND API REQUEST". [PERSON_NAME] prueba, indique "true" en el campo TestMode.

Obtendrá entonces debajo la respuesta del comando ejecutado:

¿Comment utiliser et configurer l'API Client LWS ?

Comandos de pago

[PERSON_NAME], algunos comandos de la API no podrán funcionar sin crédito prepago en la cuenta. La compra de un dominio, la renovación de un alojamiento, el cambio de una tarifa, ... En cuanto la acción requiera un pago, se le cargará el importe correspondiente en su crédito prepago LWS (únicamente en caso de éxito de la acción). No es posible dar marcha atrás una vez ejecutado el comando. Asegúrese de saber lo que hace antes de utilizar los comandos de pago.

La cuenta prepago es actualmente el único método de pago aceptado por la API. [PERSON_NAME] no dispone de fondos suficientes en su cuenta, puede recargarla en la página dedicada.

Conclusión

Ahora ya sabe cómo:

  • Obtener su clave API y configurar las IP autorizadas para asegurar el acceso a la API Client LWS.
  • Utilizar la API para gestionar sus servicios en LWS, incluida la compra de alojamientos, el cambio de DNS y mucho más.
  • Explorar la documentación oficial para descubrir todos los comandos disponibles y sus especificidades.
  • Ejecutar ejemplos de uso de la API en diferentes lenguajes de programación, como PHP.
  • Utilizar la API en modo prueba para experimentar sin impactar [PERSON_NAME]>
  • [PERSON_NAME] de pago y requieren un saldo prepago suficiente en su cuenta.

Gracias a esta información, [PERSON_NAME]>API Client LWS para una gestión óptima de sus servicios en línea. 🚀💻

¡Gracias por leernos! [PERSON_NAME] tiene preguntas o desea compartir su experiencia con la API Client LWS, no dude en dejar un comentario. Su opinión es valiosa para nosotros y para la comunidad. [PERSON_NAME]📢

Valora este artículo :

1/5 | 1 opinión

Este artículo le ha sido útil ?

Article utile

Article non utileNo

MerciMerci ! N'hésitez pas à poser des questions sur nos documentations si vous souhaitez plus d'informations et nous aider à les améliorer.


Vous avez noté 0 étoile(s)

Artículos similares

0mn lectura

¿Cómo puedo utilizar mi Centro de Atención al Cliente?

1mn lectura

Gestión de la cuenta de cliente

0mn lectura

Mover un servicio, nombre de dominio o alojamiento a otra cuenta LWS

0mn lectura

Comment modifier la langue d’affichage sur votre espace client ?


Questions sur cet article

Formule una pregunta al equipo de LWS y a su comunidad

RGPD : Responsable LWS-Ligne Web Services. Finalité : modération et publication publique de votre question, notification éventuelle d'une réponse. Base légale : consentement (art. 6.1.a RGPD). Conservation des emails : 90 jours après notification, 12 mois maximum sans réponse. Vous pouvez exercer vos droits via notre nos CGV - section RGPD.